docs: fix broken cross-references in documentation#1369
Open
wahajahmed010 wants to merge 2 commits into
Open
Conversation
Fixes collective#1158 - Remove :py: prefix from cross-references in docstrings (:py:class: -> :class:, :py:mod: -> :mod:, :py:meth: -> :meth:) - Fix unqualified references to use fully qualified names (e.g. :class:`BUSYTYPE` -> :class:`icalendar.enums.BUSYTYPE`) - Use tilde-prefixed references for cleaner display (:class:`~icalendar.cal.todo.Todo`) - Affected files: calendar.py, lazy.py, todo.py, caselessdict.py, enums.py, parser/ical/lazy.py, parser/parameter.py, parser/property.py, parser/string.py, prop/dt/date.py, prop/dt/datetime.py, prop/dt/duration.py, prop/dt/time.py
wahajahmed010
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
Documentation build overview
22 files changed ·
|
Member
|
@wahajahmed010 would you please:
For details, see https://icalendar.readthedocs.io/en/stable/contribute/index.html and https://icalendar.readthedocs.io/en/stable/contribute/development.html. Once you perform those tasks, then I'll do a review. Thank you! |
Author
|
@stevepiercy Thanks for the review! I've addressed all your feedback:
Ready for another review! 🙏 |
stevepiercy
requested changes
May 21, 2026
| Minor changes | ||
| ~~~~~~~~~~~~~ | ||
|
|
||
| - Fix broken cross-references in documentation by replacing ``:py:`` prefixed roles with standard Sphinx roles and qualifying ambiguous references. See `#1158 <https://github.com/collective/icalendar/issues/1158>`_ |
Member
There was a problem hiding this comment.
Please edit and move this to a new file at /news/1158.documentation. In v7.1.1, we migrated to an automated procedure to update CHANGES.rst, per https://icalendar.readthedocs.io/en/latest/contribute/index.html#change-log-entry-format. This also avoids merge conflicts and updating your PR repeatedly while waiting for it to get merged.
Suggested change
| - Fix broken cross-references in documentation by replacing ``:py:`` prefixed roles with standard Sphinx roles and qualifying ambiguous references. See `#1158 <https://github.com/collective/icalendar/issues/1158>`_ | |
| - Fix broken cross-references in documentation by removing ``:py`` prefixed roles and qualifying ambiguous references. @wahajahmed010 |
I'll perform a full review later.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See #1158
Changes
Remove
:py:prefix from cross-references in docstrings::py:class:→:class::py:mod:→:mod::py:meth:→:meth:Fix unqualified references to use fully qualified names:
:class:BUSYTYPE→ `:class:`icalendar.enums.BUSYTYPE:class:FBTYPE→ `:class:`icalendar.enums.FBTYPE:func:_escape_char→ `:func:`~icalendar.parser.string._escape_charUse tilde-prefixed references (
~) for cleaner displayed text while maintaining correct linking.Files changed (13)
src/icalendar/cal/calendar.pysrc/icalendar/cal/lazy.pysrc/icalendar/cal/todo.pysrc/icalendar/caselessdict.pysrc/icalendar/enums.pysrc/icalendar/parser/ical/lazy.pysrc/icalendar/parser/parameter.pysrc/icalendar/parser/property.pysrc/icalendar/parser/string.pysrc/icalendar/prop/dt/date.pysrc/icalendar/prop/dt/datetime.pysrc/icalendar/prop/dt/duration.pysrc/icalendar/prop/dt/time.pyThis PR was AI-assisted.
📚 Documentation preview 📚: https://icalendar--1369.org.readthedocs.build/